<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">

<title>rdoc: Ruby Standard Library Documentation</title>


<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>

<script src="./js/jquery-3.2.0.min.js"></script>

<script src="./js/vue.min.js"></script>
<script src="./js/js.cookie.min.js"></script>

<link href="./css/fonts.css" rel="stylesheet">
<link id='rdoccss' href="./css/rdoc.css" rel="stylesheet">
<link href="./css/carbon17.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "./";
  var index_rel_prefix = "./";
  var darkModeCsseHref = "./css/rdoc-dm.css"
  var defaultModeCssHref = "./css/rdoc.css"
  // var cssDarkmode = Cookies.get('darkmode');
  
  if( Cookies.get("darkmode") == "true") {
	$('#rdoccss').attr("href", darkModeCsseHref);
}

//  https://cssdeck.com/blog/simple-jquery-stylesheet-switcher/

document.write('<style type="text/css">body{display:none}</style>');

</script>


</head>
<body id="top" role="document" class="file">
  <!-- index.html -->
 <div id='actionbar' >
   
<div class='wrapper mdiv'>
 <ul class='grids g0'></ul>
</div> 
<!-- VERSION HEADER for 3.3.0.preview2 NOT FOUND -->
</div> <!-- end action bar -->

 <div class='wrapper hdiv'>

 

<nav id='vapp' role="navigation">
  <div id="project-navigation"    >
    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2><a href="./index.html" rel="home">Home</a></h2>

  <div id="table-of-contents-navigation"  >
    <a href="./table_of_contents.html#pages">Pages</a>
    <a href="./table_of_contents.html#classes">Classes</a>
    <a href="./table_of_contents.html#methods">Methods</a>
  </div>
</div>

    <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

  </div>
  
  <button id='toggleThing' @click="isOpen = !isOpen" _click="toggleNav()" >Show/hide navigation</button>

    <div id="project-metadata" >
      <div :class="isOpen ? 'block' : 'hidden' " id='toggleMe'>
    

    <div id="classindex-section" class="nav-section">
  <h3>Class and Module Index</h3>

  <ul class="link-list">
    <li><a href="./Object.html">Object</a>
    <li><a href="./RDoc.html">RDoc</a>
    <li><a href="./RDoc/Alias.html">RDoc::Alias</a>
    <li><a href="./RDoc/AnonClass.html">RDoc::AnonClass</a>
    <li><a href="./RDoc/AnyMethod.html">RDoc::AnyMethod</a>
    <li><a href="./RDoc/Attr.html">RDoc::Attr</a>
    <li><a href="./RDoc/ClassModule.html">RDoc::ClassModule</a>
    <li><a href="./RDoc/CodeObject.html">RDoc::CodeObject</a>
    <li><a href="./RDoc/Comment.html">RDoc::Comment</a>
    <li><a href="./RDoc/Constant.html">RDoc::Constant</a>
    <li><a href="./RDoc/Context.html">RDoc::Context</a>
    <li><a href="./RDoc/Context/Section.html">RDoc::Context::Section</a>
    <li><a href="./RDoc/CrossReference.html">RDoc::CrossReference</a>
    <li><a href="./RDoc/ERBIO.html">RDoc::ERBIO</a>
    <li><a href="./RDoc/ERBPartial.html">RDoc::ERBPartial</a>
    <li><a href="./RDoc/Encoding.html">RDoc::Encoding</a>
    <li><a href="./RDoc/Error.html">RDoc::Error</a>
    <li><a href="./RDoc/Extend.html">RDoc::Extend</a>
    <li><a href="./RDoc/Generator.html">RDoc::Generator</a>
    <li><a href="./RDoc/Generator/Darkfish.html">RDoc::Generator::Darkfish</a>
    <li><a href="./RDoc/Generator/JsonIndex.html">RDoc::Generator::JsonIndex</a>
    <li><a href="./RDoc/Generator/Markup.html">RDoc::Generator::Markup</a>
    <li><a href="./RDoc/Generator/POT.html">RDoc::Generator::POT</a>
    <li><a href="./RDoc/Generator/POT/MessageExtractor.html">RDoc::Generator::POT::MessageExtractor</a>
    <li><a href="./RDoc/Generator/POT/PO.html">RDoc::Generator::POT::PO</a>
    <li><a href="./RDoc/Generator/POT/POEntry.html">RDoc::Generator::POT::POEntry</a>
    <li><a href="./RDoc/Generator/RI.html">RDoc::Generator::RI</a>
    <li><a href="./RDoc/GhostMethod.html">RDoc::GhostMethod</a>
    <li><a href="./RDoc/I18n.html">RDoc::I18n</a>
    <li><a href="./RDoc/I18n/Locale.html">RDoc::I18n::Locale</a>
    <li><a href="./RDoc/I18n/Text.html">RDoc::I18n::Text</a>
    <li><a href="./RDoc/Include.html">RDoc::Include</a>
    <li><a href="./RDoc/Markdown.html">RDoc::Markdown</a>
    <li><a href="./RDoc/Markdown/Literals.html">RDoc::Markdown::Literals</a>
    <li><a href="./RDoc/Markup.html">RDoc::Markup</a>
    <li><a href="./RDoc/Markup/AttrChanger.html">RDoc::Markup::AttrChanger</a>
    <li><a href="./RDoc/Markup/AttrSpan.html">RDoc::Markup::AttrSpan</a>
    <li><a href="./RDoc/Markup/AttributeManager.html">RDoc::Markup::AttributeManager</a>
    <li><a href="./RDoc/Markup/Attributes.html">RDoc::Markup::Attributes</a>
    <li><a href="./RDoc/Markup/BlankLine.html">RDoc::Markup::BlankLine</a>
    <li><a href="./RDoc/Markup/BlockQuote.html">RDoc::Markup::BlockQuote</a>
    <li><a href="./RDoc/Markup/Document.html">RDoc::Markup::Document</a>
    <li><a href="./RDoc/Markup/Formatter.html">RDoc::Markup::Formatter</a>
    <li><a href="./RDoc/Markup/HardBreak.html">RDoc::Markup::HardBreak</a>
    <li><a href="./RDoc/Markup/Include.html">RDoc::Markup::Include</a>
    <li><a href="./RDoc/Markup/IndentedParagraph.html">RDoc::Markup::IndentedParagraph</a>
    <li><a href="./RDoc/Markup/List.html">RDoc::Markup::List</a>
    <li><a href="./RDoc/Markup/ListItem.html">RDoc::Markup::ListItem</a>
    <li><a href="./RDoc/Markup/Paragraph.html">RDoc::Markup::Paragraph</a>
    <li><a href="./RDoc/Markup/Parser.html">RDoc::Markup::Parser</a>
    <li><a href="./RDoc/Markup/Parser/Error.html">RDoc::Markup::Parser::Error</a>
    <li><a href="./RDoc/Markup/Parser/MyStringScanner.html">RDoc::Markup::Parser::MyStringScanner</a>
    <li><a href="./RDoc/Markup/Parser/ParseError.html">RDoc::Markup::Parser::ParseError</a>
    <li><a href="./RDoc/Markup/PreProcess.html">RDoc::Markup::PreProcess</a>
    <li><a href="./RDoc/Markup/Raw.html">RDoc::Markup::Raw</a>
    <li><a href="./RDoc/Markup/RegexpHandling.html">RDoc::Markup::RegexpHandling</a>
    <li><a href="./RDoc/Markup/Rule.html">RDoc::Markup::Rule</a>
    <li><a href="./RDoc/Markup/Table.html">RDoc::Markup::Table</a>
    <li><a href="./RDoc/Markup/ToAnsi.html">RDoc::Markup::ToAnsi</a>
    <li><a href="./RDoc/Markup/ToBs.html">RDoc::Markup::ToBs</a>
    <li><a href="./RDoc/Markup/ToHtml.html">RDoc::Markup::ToHtml</a>
    <li><a href="./RDoc/Markup/ToHtmlCrossref.html">RDoc::Markup::ToHtmlCrossref</a>
    <li><a href="./RDoc/Markup/ToHtmlSnippet.html">RDoc::Markup::ToHtmlSnippet</a>
    <li><a href="./RDoc/Markup/ToJoinedParagraph.html">RDoc::Markup::ToJoinedParagraph</a>
    <li><a href="./RDoc/Markup/ToLabel.html">RDoc::Markup::ToLabel</a>
    <li><a href="./RDoc/Markup/ToMarkdown.html">RDoc::Markup::ToMarkdown</a>
    <li><a href="./RDoc/Markup/ToRdoc.html">RDoc::Markup::ToRdoc</a>
    <li><a href="./RDoc/Markup/ToTableOfContents.html">RDoc::Markup::ToTableOfContents</a>
    <li><a href="./RDoc/Markup/ToTest.html">RDoc::Markup::ToTest</a>
    <li><a href="./RDoc/Markup/ToTtOnly.html">RDoc::Markup::ToTtOnly</a>
    <li><a href="./RDoc/Markup/Verbatim.html">RDoc::Markup::Verbatim</a>
    <li><a href="./RDoc/MetaMethod.html">RDoc::MetaMethod</a>
    <li><a href="./RDoc/MethodAttr.html">RDoc::MethodAttr</a>
    <li><a href="./RDoc/Mixin.html">RDoc::Mixin</a>
    <li><a href="./RDoc/NormalClass.html">RDoc::NormalClass</a>
    <li><a href="./RDoc/NormalModule.html">RDoc::NormalModule</a>
    <li><a href="./RDoc/Options.html">RDoc::Options</a>
    <li><a href="./RDoc/Parser.html">RDoc::Parser</a>
    <li><a href="./RDoc/Parser/C.html">RDoc::Parser::C</a>
    <li><a href="./RDoc/Parser/ChangeLog.html">RDoc::Parser::ChangeLog</a>
    <li><a href="./RDoc/Parser/ChangeLog/Git.html">RDoc::Parser::ChangeLog::Git</a>
    <li><a href="./RDoc/Parser/Markdown.html">RDoc::Parser::Markdown</a>
    <li><a href="./RDoc/Parser/RD.html">RDoc::Parser::RD</a>
    <li><a href="./RDoc/Parser/RipperStateLex.html">RDoc::Parser::RipperStateLex</a>
    <li><a href="./RDoc/Parser/RipperStateLex/InnerStateLex.html">RDoc::Parser::RipperStateLex::InnerStateLex</a>
    <li><a href="./RDoc/Parser/Ruby.html">RDoc::Parser::Ruby</a>
    <li><a href="./RDoc/Parser/RubyTools.html">RDoc::Parser::RubyTools</a>
    <li><a href="./RDoc/Parser/Simple.html">RDoc::Parser::Simple</a>
    <li><a href="./RDoc/Parser/Text.html">RDoc::Parser::Text</a>
    <li><a href="./RDoc/RD.html">RDoc::RD</a>
    <li><a href="./RDoc/RD/BlockParser.html">RDoc::RD::BlockParser</a>
    <li><a href="./RDoc/RD/Inline.html">RDoc::RD::Inline</a>
    <li><a href="./RDoc/RD/InlineParser.html">RDoc::RD::InlineParser</a>
    <li><a href="./RDoc/RDoc.html">RDoc::RDoc</a>
    <li><a href="./RDoc/RI.html">RDoc::RI</a>
    <li><a href="./RDoc/RI/Driver.html">RDoc::RI::Driver</a>
    <li><a href="./RDoc/RI/Driver/Error.html">RDoc::RI::Driver::Error</a>
    <li><a href="./RDoc/RI/Driver/NotFoundError.html">RDoc::RI::Driver::NotFoundError</a>
    <li><a href="./RDoc/RI/Error.html">RDoc::RI::Error</a>
    <li><a href="./RDoc/RI/Paths.html">RDoc::RI::Paths</a>
    <li><a href="./RDoc/RI/Task.html">RDoc::RI::Task</a>
    <li><a href="./RDoc/Require.html">RDoc::Require</a>
    <li><a href="./RDoc/RubygemsHook.html">RDoc::RubygemsHook</a>
    <li><a href="./RDoc/Servlet.html">RDoc::Servlet</a>
    <li><a href="./RDoc/SingleClass.html">RDoc::SingleClass</a>
    <li><a href="./RDoc/Stats.html">RDoc::Stats</a>
    <li><a href="./RDoc/Stats/Normal.html">RDoc::Stats::Normal</a>
    <li><a href="./RDoc/Stats/Quiet.html">RDoc::Stats::Quiet</a>
    <li><a href="./RDoc/Stats/Verbose.html">RDoc::Stats::Verbose</a>
    <li><a href="./RDoc/Store.html">RDoc::Store</a>
    <li><a href="./RDoc/Store/Error.html">RDoc::Store::Error</a>
    <li><a href="./RDoc/Store/MissingFileError.html">RDoc::Store::MissingFileError</a>
    <li><a href="./RDoc/Task.html">RDoc::Task</a>
    <li><a href="./RDoc/Text.html">RDoc::Text</a>
    <li><a href="./RDoc/TokenStream.html">RDoc::TokenStream</a>
    <li><a href="./RDoc/TomDoc.html">RDoc::TomDoc</a>
    <li><a href="./RDoc/TopLevel.html">RDoc::TopLevel</a>
    <li><a href="./Racc.html">Racc</a>
    <li><a href="./Racc/ParseError.html">Racc::ParseError</a>
    <li><a href="./Racc/Parser.html">Racc::Parser</a>
  </ul>
</div>

    </div>
  </div>
</nav>


<!--  carbon ads here -->

<div id='extraz'>
  <div class='adzbox-index'  >
   
  </div>
 </div>         


<main role="main">
<p>This is the API documentation for rdoc: Ruby Standard Library Documentation.</p>
<p>This is the API documentation for .</p>
</main>



</div>  <!--  class='wrapper hdiv' -->


<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a></p>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.</p>
<p>Based on <a href="https://github.com/ged/darkfish/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>

  
    <p><p><a href="https://ruby-doc.org">Ruby-doc.org</a> is provided by <a href="https://jamesbritt.com">James Britt</a> and <a href="https://neurogami.com">Neurogami</a>. </p><p><a href="https://jamesbritt.bandcamp.com/">Hack your world.  Feed your head.  Live curious</a>.</p>
</p>
  
  </footer>

<script type="text/javascript">


  let ads  = $("#carbonads-container").children().detach();


  function swapMode() {
    var cookieName = 'darkmode';
    var cssDarkmode = Cookies.get(cookieName);
    console.log("***** swapMode! " + cssDarkmode + " *****");


    if (cssDarkmode == "true") {
      console.log("We have dark mode, set the css to light ...");
      $('#rdoccss').attr("href", defaultModeCssHref);
      $('#cssSelect').text("Dark mode");
      cssDarkmode = "false";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    } else {
      console.log("We not have dark mode, set the css to dark ...");
      $('#rdoccss').attr("href", darkModeCsseHref);
      $('#cssSelect').text("Light mode");
      cssDarkmode = "true";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    }

    console.log("  --------------- ");
  }


const vueCssApp = new Vue({
el: '#menubar',
data: {
isDark: false
},
methods: {
toggleClass: function(event){
this.isDark = !this.isDark;
}
}
})

const vueApp = new Vue({
el: '#vapp',
data: { 
isOpen: true
},

mounted() {
this.handleResize();
this.manage_mob_classes();
window.addEventListener('resize', this.handleResize)
//this.isOpen !=  (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},
destroyed() {
window.removeEventListener('resize', this.handleResize)
},
created() {
//manage_mob_classes();
},

methods : {
isMobile() {
  return (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},

  handleResize() {
    if (!this.isMobile()) {
      this.isOpen = window.innerWidth > 800;
    }
  },

  manage_mob_classes() {
    if (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)) {
      $("nav").addClass("mob_nav");
      $("main").addClass("mob_main");
      $("#extraz").addClass("mob_extraz");
      $("#carbonads-container").addClass("mob_carbonads-container");
      this.isOpen  = false;
    } else {
      $("nav").removeClass("mob_nav") 
        $("main").removeClass("mob_main");
      $("#extraz").removeClass("mob_extraz");
      $("#carbonads-container").removeClass("mob_carbonads-container");
      this.isOpen  = true;
    }
  },

  toggleNav() {
    this.isOpen =! this.isOpen ;
    // alert("Toggle nav!");
    console.log("toggleNav() click: " + this.isOpen );
  }
}
})

$("#carbonads-container").append(ads);


$(function() {

    var darkmode = Cookies.get("darkmode");
    console.log("Document ready: " + darkmode);

    if ( darkmode  == "true" ) {
      $('#cssSelect').text("Light mode");
    } else {
      $('#cssSelect').text("Dark mode");
     }

    $('body').css('display','block');
    });

</script>

    
  </body> 
</html>

